Editing Wiki with Visual Studio Code

Visual Studio Code Installation

Install Visual Studio Code

Download Visual Studio Code

Install Visual Studio Code Extensions

• Foam for Gollum
• Markdown All in One

Add Workspace Settings

1. Open Workspace Settings (JSON) by clicking Ctrl+Shift+P and searching for it.
2. Add the following configuration there (to upload files under /upload/):

    "markdown.copyFiles.destination": {
        "/**/*": "uploads/${documentBaseName}/"
    }
   

3. Add the following configuration option to support Gollum-style alias links:

    "foam.wikilinks.order": "alias-first"
   

4. Remember to add commas (,) after appropriate settings.

Add Shortcuts to User Settings (Optional)

Click Ctrl+Shift+P and search for:

• Markdown All in One: Toggle Code Span, and click the gear icon and set its key binding to Win+Shift+C.
• Markdown All in One: Toggle Code Block, and click the gear icon and set its key binding to Win+Alt+C.

Accessing the Repository

Install Git

1. Download Git.
2. Install Git.

Install GitHub Desktop (Optional)

You can also install GitHub Desktop for a GUI.

Cloning Repository

(Use these instructions if you have write rights to the GnollHack Wiki repository. They can be granted by Sound Mind Games admins.)

1. Open your terminal (e.g. PowerShell or bash).
2. Go to the directory under which you want to clone GnollHack wiki, e.g. type cd C:\repos. If the directory does not exist, you must create it.
3. Type git clone https://github.com/hyvanmielenpelit/GnollHackWiki.git and press Enter.
4. GnollHack wiki should now install to the GnollHackWiki subdirectory.

Forking Repository and Making Pull Request

(Use these instructions if you don't have write rights to the GnollHack Wiki repository but you want to do a contribution.)

1. Go to the GnollHackWiki repository on GitHub.
2. Fork the repository by clicking the Fork badge.
   
3. Clone the forked repository to the local machine.
4. Make changes and commit them.
5. Push changes the forked repository.
6. Make a pull request to the GnollHack Wiki repository from the forked repository on GitHub.

You can read more about forking repositories and making pull requests in GitHub documentation: Creating a pull request from a fork.

How-To-Do Guide

Open Markdown Preview

Press Ctrl+Shift+V.

Creating New Page from Wiki Link

You can create a new Markdown page by holding Ctrl down while clicking a wiki link (e.g. [[New Page]]).

Add File or Image

1. Start dragging a file or an image in File Explorer.
2. Before dropping hold Shift down.
3. Drop the file into a Markdown file.
4. It should automatically upload it and create an appropriate tag for it.

Publish Changes

1. Commit changes using the Source Control view.
2. Sync them.
3. If you updated the GnollHack Wiki repository directly, it takes up to 5 minutes for the changes to appear online.